
<!DOCTYPE html>
<!--

    Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>configure-jms-cluster</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="css/style.css" rel="stylesheet">
    <script src="https://use.fontawesome.com/96c4d89611.js"></script>
  </head>
  <body>
<table id="doc-title" cellspacing="0" cellpadding="0">
  <tr>
  <td align="left" valign="top">
  <b>configure-jms-cluster</b><br />
  </td>
  </tr>
</table>
<hr />

<table width="90%" id="top-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>
		<td align="left">
		<a href="collect-log-files.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="configure-lb-weight.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class=" vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>


<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a id="configure-jms-cluster-1"></a><a id="GSRFM00008"></a><a id="configure-jms-cluster"></a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_configure_jms_cluster">configure-jms-cluster</h2>
<div class="sectionbody">
<div class="paragraph">
<p>configures the Message Queue cluster providing JMS services to a
\{product---name} cluster</p>
</div>
<div id="sthref79" class="paragraph">
<p>Synopsis</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin [asadmin-options] configure-jms-cluster [--help]
[--clustertype={conventional|enhanced}]
[--configstoretype={masterbroker|shareddb}]
[--messagestoretype={file|jdbc}]
[--dbvendor database-vendor]
[--dbuser database-user]
[--dburl database-url]
[--property (name=value)[:name=value]*]
cluster-name</code></pre>
</div>
</div>
<div id="sthref80" class="paragraph">
<p>Description</p>
</div>
<div class="paragraph">
<p>The <code>configure-jms-cluster</code> configures the Message Queue cluster
providing JMS services to a \{product---name} cluster.</p>
</div>
<div class="paragraph">
<p>This subcommand should be used before the \{product---name} cluster is
started for the first time.</p>
</div>
<div class="paragraph">
<p>This subcommand is supported in remote mode only. Remote <code>asadmin</code>
subcommands require a running domain administration server (DAS).</p>
</div>
<div id="sthref81" class="paragraph">
<p>Options</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">asadmin-options</dt>
<dd>
<p>Options for the <code>asadmin</code> utility. For information about these
options, see the <a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> help page.</p>
</dd>
<dt class="hdlist1"><code>--help</code></dt>
<dt class="hdlist1"><code>-?</code></dt>
<dd>
<p>Displays the help text for the subcommand.</p>
</dd>
<dt class="hdlist1"><code>--clustertype</code></dt>
<dd>
<p>The type of Message Queue cluster to configure. The value
<code>conventional</code> specifies a conventional cluster, and the value
<code>enhanced</code> specifies an enhanced, high-availability cluster. For
information about these cluster types of Message Queue clusters, see
"<a href="../../openmq/mq-tech-over/broker-clusters.html#GMTOV00028">Broker Clusters</a>" in Open Message Queue Technical
Overview.<br>
The default value is <code>conventional</code>.<br>
If <code>enhanced</code> is specified, the <code>configstoretype</code> and
<code>messagestoretype</code> options are ignored.</p>
</dd>
<dt class="hdlist1"><code>--configstoretype</code></dt>
<dd>
<p>The type of data store for configuration data in a conventional
cluster. The value <code>masterbroker</code> specifies the use of a master broker
to store and manage the configuration data. The value <code>shareddb</code>
specifies the use of a shared database to store the configuration
data.<br>
The default value is <code>masterbroker</code>.<br>
This option is ignored if <code>clustertype</code> is set to <code>enhanced</code>.</p>
</dd>
<dt class="hdlist1"><code>--messagestoretype</code></dt>
<dd>
<p>  The type of data store for message data in brokers in a conventional
  cluster. The value <code>file</code> specifies a file store. The value <code>jdbc</code>
  specifies a JDBC store.<br>
  The default value is <code>file</code>.<br>
  This option is ignored if <code>clustertype</code> is set to <code>enhanced</code>.
<code>--dbvendor</code><br></p>
</dd>
<dt class="hdlist1"><code>--dbuser</code></dt>
<dt class="hdlist1"><code>--dburl</code></dt>
<dd>
<p>The database vendor, user, and access url of the JDBC database to use
in any of these situations:<br></p>
<div class="ulist">
<ul>
<li>
<p>When <code>clustertype</code> is set to <code>enhanced</code></p>
</li>
<li>
<p>When <code>configstoretype</code> is set to <code>shareddb</code></p>
</li>
<li>
<p>When <code>messagestoretype</code> is set to <code>jdbc</code><br>
For information about supported vendors and the formats of access urls
for each vendor, see "<a href="../../openmq/mq-admin-guide/persistence-services.html#GMADG00244">JDBC-Based Persistence</a>" in
Open Message Queue Administration Guide.<br></p>
</li>
</ul>
</div>
</dd>
</dl>
</div>
<table class="tableblock frame-all grid-all spread">
<colgroup>
<col style="width: 100%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
<p>Note:</p>
</div>
<div class="paragraph">
<p>To specify the password of the JDBC database user, use the
<code>--passwordfile</code> utility option of the
<a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> command after adding the
entry <code>AS_ADMIN_JMSDBPASSWORD</code> to the password file.</p>
</div></div></td>
</tr>
</tbody>
</table>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>--property</code></dt>
<dd>
<p>A list of additional database-vendor-specific properties to configure
the JDBC database for use by the Message Queue cluster. Specify
properties as a colon (<code>:</code>) separated list of property names and
values in the form:<br></p>
</dd>
</dl>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">prop1name=prop1value:prop2name=prop2value</code></pre>
</div>
</div>
<div id="sthref82" class="paragraph">
<p>Operands</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">cluster-name</dt>
<dd>
<p>The name of the \{product---name} cluster for which the Message Queue
cluster is to provide JMS services.<br>
Because \{product---name} uses the cluster name to uniquely identify
database tables the Message Queue cluster might require, the length of
the name is restricted in the following situations:<br></p>
<div class="ulist">
<ul>
<li>
<p>If <code>clustertype</code> is set to <code>enhanced</code>, the name can be no longer
than n–21 characters, where n is the maximum table name length allowed
by the database.</p>
</li>
<li>
<p>If <code>configstoretype</code> is set to <code>shareddb</code>, the name can be no longer
than n–19 characters, where n is the maximum table name length allowed
by the database.</p>
</li>
</ul>
</div>
</dd>
</dl>
</div>
<div id="sthref83" class="paragraph">
<p>Exit Status</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>subcommand executed successfully</p>
</dd>
<dt class="hdlist1">1</dt>
<dd>
<p>error in executing the subcommand</p>
</dd>
</dl>
</div>
<div id="sthref84" class="paragraph">
<p>See Also</p>
</div>
<div class="paragraph">
<p><a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a></p>
</div>
</div>
</div>

<hr />

<table width="90%" id="bottom-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>		
		<td align="left">
		<a href="collect-log-files.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="configure-lb-weight.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class="vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>

<span id="copyright">
        <img src="/resource/reference/img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;            
        <span >Copyright&nbsp;&copy;&nbsp;2019,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
</span>

</body>
</html>
